﻿/*
	Copyright (c) 2013 Andrew Meyer

	Permission is hereby granted, free of charge, to any person obtaining a copy of this software
	and associated documentation files (the "Software"), to deal in the Software without
	restriction, including without limitation the right to use, copy, modify, merge, publish,
	distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
	Software is furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in all copies or
	substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
	BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
	DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

using System.Windows.Input;
using System.Windows.Media.Media3D;

namespace Ascend
{
	/// <summary>
	/// Handler definition for Ascend.SceneNode mouse button events.
	/// </summary>
	/// <param name="sender">
	/// The source of the event.
	/// </param>
	/// <param name="e">
	/// The event args associated with the event.
	/// </param>
	public delegate void SceneNodeMouseButtonEventHandler(object sender,
		SceneNodeMouseButtonEventArgs e);


	/// <summary>
	/// Arguments for use in Ascend.SceneNode mouse button event handlers. This class cannot be
	/// inherited.
	/// </summary>
	public sealed class SceneNodeMouseButtonEventArgs : SceneNodeMouseEventArgs
	{
		#region Lifecycle
		internal SceneNodeMouseButtonEventArgs(MouseButtonEventArgs e, SceneViewer3D viewer,
			ModelSceneNode source, RayHitTestResult result)
			: base(e, viewer, source, result)
		{ }
		#endregion

		#region Public Properties
		/// <summary>
		/// Gets the state of the button associated with this event.
		/// </summary>
		public MouseButtonState ButtonState
		{
			get
			{
				return ((MouseButtonEventArgs)_sourceArgs).ButtonState;
			}
		}

		/// <summary>
		/// Gets the button associated with this event.
		/// </summary>
		public MouseButton ChangedButton
		{
			get
			{
				return ((MouseButtonEventArgs)_sourceArgs).ChangedButton;
			}
		}

		/// <summary>
		/// Gets the number of times the button was clicked.
		/// </summary>
		public int ClickCount
		{
			get
			{
				return ((MouseButtonEventArgs)_sourceArgs).ClickCount;
			}
		}
		#endregion
	}
}
